<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: /data/users/hoss/faiss/IndexBinaryIVF.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">/data/users/hoss/faiss/IndexBinaryIVF.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) Facebook, Inc. and its affiliates.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * This source code is licensed under the MIT license found in the</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#ifndef FAISS_INDEX_BINARY_IVF_H</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define FAISS_INDEX_BINARY_IVF_H</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &quot;IndexBinary.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &quot;IndexIVF.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &quot;Clustering.h&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;Heap.h&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">struct </span>BinaryInvertedListScanner;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">/** Index based on a inverted file (IVF)</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * In the inverted file, the quantizer (an IndexBinary instance) provides a</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * quantization index for each vector to be added. The quantization</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * index maps to a list (aka inverted list or posting list), where the</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> * id of the vector is stored.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"> * Otherwise the object is similar to the IndexIVF</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html">   35</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a> : <a class="code" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> {<span class="comment"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">    /// Acess to the actual data</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#a094ef9572645ff86a76ff4df967bf65a">   37</a></span>&#160;<span class="comment"></span>    <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *<a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a094ef9572645ff86a76ff4df967bf65a">invlists</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordtype">bool</span> own_invlists;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#ae9890e0946f3aba99ccad6b637df0c8b">   40</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#ae9890e0946f3aba99ccad6b637df0c8b">nprobe</a>;            <span class="comment">///&lt; number of probes at query time</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#a18ffc5dbf15b4a86a8c868ca845ea4c9">   41</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a18ffc5dbf15b4a86a8c868ca845ea4c9">max_codes</a>;         <span class="comment">///&lt; max nb of codes to visit to do a query</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">    /** Select between using a heap or counting to select the k smallest values</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">     * when scanning inverted lists.</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#abcab702ebe1814ff432401bfd39df492">   46</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#abcab702ebe1814ff432401bfd39df492">use_heap</a> = <span class="keyword">true</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">    /// map for direct access to the elements. Enables reconstruct().</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#a1ae109b12efeb9b3349c1de2c6d480e5">   49</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a1ae109b12efeb9b3349c1de2c6d480e5">maintain_direct_map</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    std::vector&lt;long&gt; direct_map;</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#a5c08ac8e6c1444e61b9f357cfba34e2e">   52</a></span>&#160;    <a class="code" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> *<a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a5c08ac8e6c1444e61b9f357cfba34e2e">quantizer</a>;   <span class="comment">///&lt; quantizer that maps vectors to inverted lists</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#a9eb4370bcc95994822c3a81c290fa919">   53</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a9eb4370bcc95994822c3a81c290fa919">nlist</a>;             <span class="comment">///&lt; number of possible key values</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#a2c7bc3be67d829d49ac1ab2afc4f6b0c">   55</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a2c7bc3be67d829d49ac1ab2afc4f6b0c">own_fields</a>;          <span class="comment">///&lt; whether object owns the quantizer</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#a0c3d371cf3985da70b6dacac74f03491">   57</a></span>&#160;    <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a0c3d371cf3985da70b6dacac74f03491">cp</a>; <span class="comment">///&lt; to override default clustering params</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexBinaryIVF.html#ae4b4048070a6fc5aa3226a2edf42db5e">   58</a></span>&#160;<span class="comment"></span>    <a class="code" href="structfaiss_1_1Index.html">Index</a> *<a class="code" href="structfaiss_1_1IndexBinaryIVF.html#ae4b4048070a6fc5aa3226a2edf42db5e">clustering_index</a>; <span class="comment">///&lt; to override index used during clustering</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">    /** The Inverted file takes a quantizer (an IndexBinary) on input,</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">     * which implements the function mapping a vector to a list</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">     * identifier. The pointer is borrowed: the quantizer should not</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">     * be deleted while the IndexBinaryIVF is in use.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <a class="code" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a>(<a class="code" href="structfaiss_1_1IndexBinary.html">IndexBinary</a> *<a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a5c08ac8e6c1444e61b9f357cfba34e2e">quantizer</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a9eb4370bcc95994822c3a81c290fa919">nlist</a>);</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <a class="code" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a>();</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    ~<a class="code" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a9dfe26312102f0010940fd2fbdf87d85">reset</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">    /// Trains the quantizer</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a4b4b1ba42e6af7c30ccbaf0fc0f38034">train</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, <span class="keyword">const</span> uint8_t *x) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#aaa0eb1eca49892304ceaa11bd3a5ffa1">add</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, <span class="keyword">const</span> uint8_t *x) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a8f5fc7b1cc59623154f7922459d8c7bb">add_with_ids</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, <span class="keyword">const</span> uint8_t *x, <span class="keyword">const</span> <span class="keywordtype">long</span> *xids) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">    /// same as add_with_ids, with precomputed coarse quantizer</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a6f74afc490b61ba896ecfad037c9a429">add_core</a> (<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, <span class="keyword">const</span> uint8_t * x, <span class="keyword">const</span> <span class="keywordtype">long</span> *xids,</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;                   <span class="keyword">const</span> <span class="keywordtype">long</span> *precomputed_idx);</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">    /** Search a set of vectors, that are pre-quantized by the IVF</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">     *  quantizer. Fill in the corresponding heaps with the query</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment">     *  results. search() calls this.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">     * @param n      nb of vectors to query</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">     * @param x      query vectors, size nx * d</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">     * @param assign coarse quantization indices, size nx * nprobe</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment">     * @param centroid_dis</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">     *               distances to coarse centroids, size nx * nprobe</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment">     * @param distance</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment">     *               output distances, size n * k</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment">     * @param labels output labels, size n * k</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment">     * @param store_pairs store inv list index + inv list offset</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment">     *                     instead in upper/lower 32 bit of result,</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment">     *                     instead of ids (used for reranking).</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment">     * @param params used to override the object&#39;s search parameters</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a4f33ec7083279f26c0966c5445ec702d">search_preassigned</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, <span class="keyword">const</span> uint8_t *x, <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> k,</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;                            <span class="keyword">const</span> <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *<a class="code" href="structfaiss_1_1IndexBinary.html#a27c32414471c57138b248583fc0c5f8c">assign</a>,</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;                            <span class="keyword">const</span> int32_t *centroid_dis,</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;                            int32_t *distances, <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *labels,</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;                            <span class="keywordtype">bool</span> store_pairs,</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;                            <span class="keyword">const</span> <a class="code" href="structfaiss_1_1IVFSearchParameters.html">IVFSearchParameters</a> *params=<span class="keyword">nullptr</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;                            ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="structfaiss_1_1BinaryInvertedListScanner.html">BinaryInvertedListScanner</a> *get_InvertedListScanner (</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;                                         <span class="keywordtype">bool</span> store_pairs=<span class="keyword">false</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">    /** assign the vectors, then call search_preassign */</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#aeaf24ee802fe8f43879c735c363b6fd5">search</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, <span class="keyword">const</span> uint8_t *x, <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> k,</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;                        int32_t *distances, <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *labels) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#ad233d3fcf4e001849301c0fbeb675f81">reconstruct</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> key, uint8_t *recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment">    /** Reconstruct a subset of the indexed vectors.</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">     * Overrides default implementation to bypass reconstruct() which requires</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment">     * direct_map to be maintained.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment">     * @param i0     first vector to reconstruct</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment">     * @param ni     nb of vectors to reconstruct</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">     * @param recons output array of reconstructed vectors, size ni * d / 8</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a4a8cd9437b9adc21696aefe1fa440a22">reconstruct_n</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> i0, <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> ni, uint8_t *recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">    /** Similar to search, but also reconstructs the stored vectors (or an</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment">     * approximation in the case of lossy coding) for the search results.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">     * Overrides default implementation to avoid having to maintain direct_map</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">     * and instead fetch the code offsets through the `store_pairs` flag in</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment">     * search_preassigned().</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">     * @param recons      reconstructed vectors size (n, k, d / 8)</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a75260a5d45fb24a9a3c3462786f1de4d">search_and_reconstruct</a>(<a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> n, <span class="keyword">const</span> uint8_t *x, <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> k,</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;                                int32_t *distances, <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> *labels,</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;                                uint8_t *recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">    /** Reconstruct a vector given the location in terms of (inv list index +</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">     * inv list offset) instead of the id.</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment">     * Useful for reconstructing when the direct_map is not maintained and</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment">     * the inv list offset is computed by search_preassigned() with</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">     * `store_pairs` set.</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a9e0d01c30760152fbac8f08bb5825de4">reconstruct_from_offset</a>(<span class="keywordtype">long</span> list_no, <span class="keywordtype">long</span> offset,</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;                                         uint8_t* recons) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment">    /// Dataset manipulation functions</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;    <span class="keywordtype">long</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a06d0e73e7ece9689000f936e7f1e2960">remove_ids</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>&amp; sel) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">    /** moves the entries from another dataset to self. On output,</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">     * other is empty. add_id is added to all moved ids (for</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">     * sequential ids, this would be this-&gt;ntotal */</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a5296e62b0524f13ff66c61fb7db499a2">merge_from</a>(<a class="code" href="structfaiss_1_1IndexBinaryIVF.html">IndexBinaryIVF</a>&amp; other, <a class="code" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> add_id);</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;    <span class="keywordtype">size_t</span> get_list_size(<span class="keywordtype">size_t</span> list_no)<span class="keyword"> const</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="keyword">    </span>{ <span class="keywordflow">return</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a094ef9572645ff86a76ff4df967bf65a">invlists</a>-&gt;<a class="code" href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">list_size</a>(list_no); }</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment">    /** intialize a direct map</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment">     * @param new_maintain_direct_map    if true, create a direct map,</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment">     *                                   else clear it</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexBinaryIVF.html#a280d0a3958664c3eb4164fcb62496b00">make_direct_map</a>(<span class="keywordtype">bool</span> new_maintain_direct_map=<span class="keyword">true</span>);</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;    <span class="keywordtype">void</span> replace_invlists(<a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il, <span class="keywordtype">bool</span> own=<span class="keyword">false</span>);</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;};</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;</div>
<div class="line"><a name="l00176"></a><span class="lineno"><a class="line" href="structfaiss_1_1BinaryInvertedListScanner.html">  176</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1BinaryInvertedListScanner.html">BinaryInvertedListScanner</a> {</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;    <span class="keyword">using</span> idx_t = <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a>;</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;<span class="comment">    /// from now on we handle this query.</span></div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1BinaryInvertedListScanner.html#a22bf6ac0128e4e45768f91b4de58fdb6">set_query</a> (<span class="keyword">const</span> uint8_t *query_vector) = 0;</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment">    /// following codes come from this inverted list</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1BinaryInvertedListScanner.html#ae28e1381cb4c16ff9941c909fe9c4122">set_list</a> (idx_t list_no, uint8_t coarse_dis) = 0;</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="comment">    /// compute a single query-to-code distance</span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> uint32_t <a class="code" href="structfaiss_1_1BinaryInvertedListScanner.html#ac33be0f074b682e9afc44bd7cf0741b2">distance_to_code</a> (<span class="keyword">const</span> uint8_t *code) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">    /** compute the distances to codes. (distances, labels) should be</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment">     * organized as a min- or max-heap</span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment">     * @param n      number of codes to scan</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment">     * @param codes  codes to scan (n * code_size)</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment">     * @param ids        corresponding ids (ignored if store_pairs)</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment">     * @param distances  heap distances (size k)</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment">     * @param labels     heap labels (size k)</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment">     * @param k          heap size</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1BinaryInvertedListScanner.html#a9ddb2bb0b513829b39528463c46f90f5">scan_codes</a> (<span class="keywordtype">size_t</span> n,</div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;                               <span class="keyword">const</span> uint8_t *codes,</div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;                               <span class="keyword">const</span> idx_t *ids,</div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;                               int32_t *distances, idx_t *labels,</div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;                               <span class="keywordtype">size_t</span> k) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;</div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1BinaryInvertedListScanner.html">BinaryInvertedListScanner</a> () {}</div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;</div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;};</div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;</div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;}  <span class="comment">// namespace faiss</span></div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="preprocessor">#endif  // FAISS_INDEX_BINARY_IVF_H</span></div>
<div class="ttc" id="structfaiss_1_1BinaryInvertedListScanner_html_a22bf6ac0128e4e45768f91b4de58fdb6"><div class="ttname"><a href="structfaiss_1_1BinaryInvertedListScanner.html#a22bf6ac0128e4e45768f91b4de58fdb6">faiss::BinaryInvertedListScanner::set_query</a></div><div class="ttdeci">virtual void set_query(const uint8_t *query_vector)=0</div><div class="ttdoc">from now on we handle this query. </div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_ae9890e0946f3aba99ccad6b637df0c8b"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#ae9890e0946f3aba99ccad6b637df0c8b">faiss::IndexBinaryIVF::nprobe</a></div><div class="ttdeci">size_t nprobe</div><div class="ttdoc">number of probes at query time </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00040">IndexBinaryIVF.h:40</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a6f74afc490b61ba896ecfad037c9a429"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a6f74afc490b61ba896ecfad037c9a429">faiss::IndexBinaryIVF::add_core</a></div><div class="ttdeci">void add_core(idx_t n, const uint8_t *x, const long *xids, const long *precomputed_idx)</div><div class="ttdoc">same as add_with_ids, with precomputed coarse quantizer </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00064">IndexBinaryIVF.cpp:64</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a9e0d01c30760152fbac8f08bb5825de4"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a9e0d01c30760152fbac8f08bb5825de4">faiss::IndexBinaryIVF::reconstruct_from_offset</a></div><div class="ttdeci">virtual void reconstruct_from_offset(long list_no, long offset, uint8_t *recons) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00206">IndexBinaryIVF.cpp:206</a></div></div>
<div class="ttc" id="structfaiss_1_1BinaryInvertedListScanner_html_ae28e1381cb4c16ff9941c909fe9c4122"><div class="ttname"><a href="structfaiss_1_1BinaryInvertedListScanner.html#ae28e1381cb4c16ff9941c909fe9c4122">faiss::BinaryInvertedListScanner::set_list</a></div><div class="ttdeci">virtual void set_list(idx_t list_no, uint8_t coarse_dis)=0</div><div class="ttdoc">following codes come from this inverted list </div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00035">IndexBinaryIVF.h:35</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a1ae109b12efeb9b3349c1de2c6d480e5"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a1ae109b12efeb9b3349c1de2c6d480e5">faiss::IndexBinaryIVF::maintain_direct_map</a></div><div class="ttdeci">bool maintain_direct_map</div><div class="ttdoc">map for direct access to the elements. Enables reconstruct(). </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00049">IndexBinaryIVF.h:49</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a0c3d371cf3985da70b6dacac74f03491"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a0c3d371cf3985da70b6dacac74f03491">faiss::IndexBinaryIVF::cp</a></div><div class="ttdeci">ClusteringParameters cp</div><div class="ttdoc">to override default clustering params </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00057">IndexBinaryIVF.h:57</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a4f33ec7083279f26c0966c5445ec702d"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a4f33ec7083279f26c0966c5445ec702d">faiss::IndexBinaryIVF::search_preassigned</a></div><div class="ttdeci">void search_preassigned(idx_t n, const uint8_t *x, idx_t k, const idx_t *assign, const int32_t *centroid_dis, int32_t *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00637">IndexBinaryIVF.cpp:637</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a9eb4370bcc95994822c3a81c290fa919"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a9eb4370bcc95994822c3a81c290fa919">faiss::IndexBinaryIVF::nlist</a></div><div class="ttdeci">size_t nlist</div><div class="ttdoc">number of possible key values </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00053">IndexBinaryIVF.h:53</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelector_html"><div class="ttname"><a href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00054">AuxIndexStructures.h:54</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a9bd256053ee360473842105460fe285f"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">faiss::InvertedLists::list_size</a></div><div class="ttdeci">virtual size_t list_size(size_t list_no) const =0</div><div class="ttdoc">get the size of a list </div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a5c08ac8e6c1444e61b9f357cfba34e2e"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a5c08ac8e6c1444e61b9f357cfba34e2e">faiss::IndexBinaryIVF::quantizer</a></div><div class="ttdeci">IndexBinary * quantizer</div><div class="ttdoc">quantizer that maps vectors to inverted lists </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00052">IndexBinaryIVF.h:52</a></div></div>
<div class="ttc" id="structfaiss_1_1IVFSearchParameters_html"><div class="ttname"><a href="structfaiss_1_1IVFSearchParameters.html">faiss::IVFSearchParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00060">IndexIVF.h:60</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00031">InvertedLists.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a2c7bc3be67d829d49ac1ab2afc4f6b0c"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a2c7bc3be67d829d49ac1ab2afc4f6b0c">faiss::IndexBinaryIVF::own_fields</a></div><div class="ttdeci">bool own_fields</div><div class="ttdoc">whether object owns the quantizer </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00055">IndexBinaryIVF.h:55</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a5296e62b0524f13ff66c61fb7db499a2"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a5296e62b0524f13ff66c61fb7db499a2">faiss::IndexBinaryIVF::merge_from</a></div><div class="ttdeci">virtual void merge_from(IndexBinaryIVF &amp;other, idx_t add_id)</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00292">IndexBinaryIVF.cpp:292</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a01749bbdbd3b7ec6bb9390257ab16c5c"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">faiss::IndexBinary::idx_t</a></div><div class="ttdeci">Index::idx_t idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00037">IndexBinary.h:37</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a280d0a3958664c3eb4164fcb62496b00"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a280d0a3958664c3eb4164fcb62496b00">faiss::IndexBinaryIVF::make_direct_map</a></div><div class="ttdeci">void make_direct_map(bool new_maintain_direct_map=true)</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00104">IndexBinaryIVF.cpp:104</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a0e485a7189eec2675032486d3b12cf88"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">faiss::IndexBinary::d</a></div><div class="ttdeci">int d</div><div class="ttdoc">vector dimension </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00041">IndexBinary.h:41</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_ae4b4048070a6fc5aa3226a2edf42db5e"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#ae4b4048070a6fc5aa3226a2edf42db5e">faiss::IndexBinaryIVF::clustering_index</a></div><div class="ttdeci">Index * clustering_index</div><div class="ttdoc">to override index used during clustering </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00058">IndexBinaryIVF.h:58</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_ad3f0d3071f987baabbdd3da4500c87ea"><div class="ttname"><a href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">faiss::Index::idx_t</a></div><div class="ttdeci">long idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00062">Index.h:62</a></div></div>
<div class="ttc" id="structfaiss_1_1BinaryInvertedListScanner_html_ac33be0f074b682e9afc44bd7cf0741b2"><div class="ttname"><a href="structfaiss_1_1BinaryInvertedListScanner.html#ac33be0f074b682e9afc44bd7cf0741b2">faiss::BinaryInvertedListScanner::distance_to_code</a></div><div class="ttdeci">virtual uint32_t distance_to_code(const uint8_t *code) const =0</div><div class="ttdoc">compute a single query-to-code distance </div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a4b4b1ba42e6af7c30ccbaf0fc0f38034"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a4b4b1ba42e6af7c30ccbaf0fc0f38034">faiss::IndexBinaryIVF::train</a></div><div class="ttdeci">void train(idx_t n, const uint8_t *x) override</div><div class="ttdoc">Trains the quantizer. </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00253">IndexBinaryIVF.cpp:253</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_abcab702ebe1814ff432401bfd39df492"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#abcab702ebe1814ff432401bfd39df492">faiss::IndexBinaryIVF::use_heap</a></div><div class="ttdeci">bool use_heap</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00046">IndexBinaryIVF.h:46</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinary_html_a27c32414471c57138b248583fc0c5f8c"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html#a27c32414471c57138b248583fc0c5f8c">faiss::IndexBinary::assign</a></div><div class="ttdeci">void assign(idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1)</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8cpp_source.html#l00028">IndexBinary.cpp:28</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a9dfe26312102f0010940fd2fbdf87d85"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a9dfe26312102f0010940fd2fbdf87d85">faiss::IndexBinaryIVF::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdoc">Removes all elements from the database. </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00211">IndexBinaryIVF.cpp:211</a></div></div>
<div class="ttc" id="structfaiss_1_1BinaryInvertedListScanner_html_a9ddb2bb0b513829b39528463c46f90f5"><div class="ttname"><a href="structfaiss_1_1BinaryInvertedListScanner.html#a9ddb2bb0b513829b39528463c46f90f5">faiss::BinaryInvertedListScanner::scan_codes</a></div><div class="ttdeci">virtual size_t scan_codes(size_t n, const uint8_t *codes, const idx_t *ids, int32_t *distances, idx_t *labels, size_t k) const =0</div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a18ffc5dbf15b4a86a8c868ca845ea4c9"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a18ffc5dbf15b4a86a8c868ca845ea4c9">faiss::IndexBinaryIVF::max_codes</a></div><div class="ttdeci">size_t max_codes</div><div class="ttdoc">max nb of codes to visit to do a query </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00041">IndexBinaryIVF.h:41</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a8f5fc7b1cc59623154f7922459d8c7bb"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a8f5fc7b1cc59623154f7922459d8c7bb">faiss::IndexBinaryIVF::add_with_ids</a></div><div class="ttdeci">void add_with_ids(idx_t n, const uint8_t *x, const long *xids) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00060">IndexBinaryIVF.cpp:60</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_aaa0eb1eca49892304ceaa11bd3a5ffa1"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#aaa0eb1eca49892304ceaa11bd3a5ffa1">faiss::IndexBinaryIVF::add</a></div><div class="ttdeci">void add(idx_t n, const uint8_t *x) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00056">IndexBinaryIVF.cpp:56</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a06d0e73e7ece9689000f936e7f1e2960"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a06d0e73e7ece9689000f936e7f1e2960">faiss::IndexBinaryIVF::remove_ids</a></div><div class="ttdeci">long remove_ids(const IDSelector &amp;sel) override</div><div class="ttdoc">Dataset manipulation functions. </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00217">IndexBinaryIVF.cpp:217</a></div></div>
<div class="ttc" id="structfaiss_1_1BinaryInvertedListScanner_html"><div class="ttname"><a href="structfaiss_1_1BinaryInvertedListScanner.html">faiss::BinaryInvertedListScanner</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00176">IndexBinaryIVF.h:176</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html">faiss::ClusteringParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00022">Clustering.h:22</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinary_html"><div class="ttname"><a href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexBinary_8h_source.html#l00036">IndexBinary.h:36</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_aeaf24ee802fe8f43879c735c363b6fd5"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#aeaf24ee802fe8f43879c735c363b6fd5">faiss::IndexBinaryIVF::search</a></div><div class="ttdeci">virtual void search(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00127">IndexBinaryIVF.cpp:127</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html"><div class="ttname"><a href="structfaiss_1_1Index.html">faiss::Index</a></div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00061">Index.h:61</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a75260a5d45fb24a9a3c3462786f1de4d"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a75260a5d45fb24a9a3c3462786f1de4d">faiss::IndexBinaryIVF::search_and_reconstruct</a></div><div class="ttdeci">void search_and_reconstruct(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00171">IndexBinaryIVF.cpp:171</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a4a8cd9437b9adc21696aefe1fa440a22"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a4a8cd9437b9adc21696aefe1fa440a22">faiss::IndexBinaryIVF::reconstruct_n</a></div><div class="ttdeci">void reconstruct_n(idx_t i0, idx_t ni, uint8_t *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00152">IndexBinaryIVF.cpp:152</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_ad233d3fcf4e001849301c0fbeb675f81"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#ad233d3fcf4e001849301c0fbeb675f81">faiss::IndexBinaryIVF::reconstruct</a></div><div class="ttdeci">void reconstruct(idx_t key, uint8_t *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8cpp_source.html#l00144">IndexBinaryIVF.cpp:144</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexBinaryIVF_html_a094ef9572645ff86a76ff4df967bf65a"><div class="ttname"><a href="structfaiss_1_1IndexBinaryIVF.html#a094ef9572645ff86a76ff4df967bf65a">faiss::IndexBinaryIVF::invlists</a></div><div class="ttdeci">InvertedLists * invlists</div><div class="ttdoc">Acess to the actual data. </div><div class="ttdef"><b>Definition:</b> <a href="IndexBinaryIVF_8h_source.html#l00037">IndexBinaryIVF.h:37</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
